// --------------------------------------------------------------------------------------------------------------------
// <copyright file="FilePlayerProxy.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Runtime
{
    using System;
    using System.Collections.Concurrent;
    using System.Collections.Generic;
    using System.Linq;
    using System.Runtime.Serialization;
    using System.Threading;

    /// <summary>
    /// Agent that plays back a file containing serialized messages.
    /// </summary>
    [DataContract]
    public class FilePlayerProxy : FilePlayerAgent
    {
        /// <summary>
        /// The type of xml serialization. True for binary, false for xml.
        /// </summary>
        [DataMember(Name = "BinarySerialization")]
        private readonly bool binarySerialization;

        /// <summary>
        /// Initializes a new instance of the FilePlayerProxy class
        /// </summary>
        /// <param name="name">The name of the player agent.</param>
        /// <param name="filePath">The path to the file to play back.</param>
        /// <param name="messageTypes">The types of messages played back by this agent.</param>
        /// <param name="timerAgent">The timer agent to subscribe to. This needs to be a 1ms timer.</param>
        /// <param name="binarySerialization">If true, the file must be in binary xml format</param>
        /// <param name="skipAheadToFirstMessage">Flag indicating if recording start time is initialized to first message time. 
        /// This should not be enabled for multiple players</param>
        public FilePlayerProxy(string name, string filePath, Type[] messageTypes, IProducer<TimerMessage> timerAgent, bool binarySerialization = true, bool skipAheadToFirstMessage = false)
            : base(name, filePath, messageTypes, timerAgent, skipAheadToFirstMessage)
        {
            this.binarySerialization = binarySerialization;
        }

        /// <summary>
        /// Creates the right type of file reader. 
        /// </summary>
        /// <returns>A well-configured reader</returns>
        protected override IFileReader CreateReader()
        {
            return new SerializedFileReader(this.PublishedTypes, this.binarySerialization);
        }
    }
}
